home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / a_man / cat7 / timod.z / timod
Encoding:
Text File  |  2002-10-03  |  8.6 KB  |  133 lines

  1.  
  2.  
  3.  
  4. ttttiiiimmmmoooodddd((((7777))))                                                              ttttiiiimmmmoooodddd((((7777))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _tttt_iiii_mmmm_oooo_dddd - Transport Interface cooperating STREAMS module
  10.  
  11. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  12.      _tttt_iiii_mmmm_oooo_dddd is a STREAMS module for use with the Transport Interface (TI)
  13.      functions of the Network Services library.  The _tttt_iiii_mmmm_oooo_dddd module converts a
  14.      set of _iiii_oooo_cccc_tttt_llll(2) calls into STREAMS messages that may be consumed by a
  15.      transport protocol provider which supports the Transport Interface.  This
  16.      allows a user to initiate certain TI functions as atomic operations.
  17.  
  18.      The _tttt_iiii_mmmm_oooo_dddd module must be pushed onto only a stream terminated by a
  19.      transport protocol provider which supports the TI.
  20.  
  21.      All STREAMS messages, with the exception of the message types generated
  22.      from the _iiii_oooo_cccc_tttt_llll commands described below, will be transparently passed to
  23.      the neighboring STREAMS module or driver.  The messages generated from
  24.      the following _iiii_oooo_cccc_tttt_llll commands are recognized and processed by the _tttt_iiii_mmmm_oooo_dddd
  25.      module.  The format of the _iiii_oooo_cccc_tttt_llll call is:
  26.  
  27.           _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_ssss_yyyy_ssss_////_ssss_tttt_rrrr_oooo_pppp_tttt_ssss_...._hhhh_>>>>
  28.                     _----
  29.                     _----
  30.           _ssss_tttt_rrrr_uuuu_cccc_tttt _ssss_tttt_rrrr_iiii_oooo_cccc_tttt_llll _ssss_tttt_rrrr_iiii_oooo_cccc_tttt_llll_;;;;
  31.                     _----
  32.                     _----
  33.           _ssss_tttt_rrrr_iiii_oooo_cccc_tttt_llll_...._iiii_cccc______cccc_mmmm_dddd _==== _c_m_d_;;;;
  34.           _ssss_tttt_rrrr_iiii_oooo_cccc_tttt_llll_...._iiii_cccc______tttt_iiii_mmmm_eeee_oooo_uuuu_tttt _==== _IIII_NNNN_FFFF_TTTT_IIII_MMMM_;;;;
  35.           _ssss_tttt_rrrr_iiii_oooo_cccc_tttt_llll_...._iiii_cccc______llll_eeee_nnnn _==== _s_i_z_e_;;;;
  36.           _ssss_tttt_rrrr_iiii_oooo_cccc_tttt_llll_...._iiii_cccc______dddd_pppp _==== _((((_cccc_hhhh_aaaa_rrrr _****_))))_b_u_f
  37.           _iiii_oooo_cccc_tttt_llll_((((_ffff_iiii_llll_dddd_eeee_ssss_,,,, _IIII______SSSS_TTTT_RRRR_,,,, _&&&&_ssss_tttt_rrrr_iiii_oooo_cccc_tttt_llll_))))_;;;;
  38.  
  39.      Where, on issuance, _s_i_z_e is the size of the appropriate TI message to be
  40.      sent to the transport provider and on return _s_i_z_e is the size of the
  41.      appropriate TI message from the transport provider in response to the
  42.      issued TI message.  _b_u_f is a pointer to a buffer large enough to hold the
  43.      contents of the appropriate TI messages.  The TI message types are
  44.      defined in _<<<<_ssss_yyyy_ssss_////_tttt_iiii_hhhh_dddd_rrrr_...._hhhh_>>>>.  The possible values for the _c_m_d field are:
  45.  
  46.      _TTTT_IIII______BBBB_IIII_NNNN_DDDD        Bind an address to the underlying transport protocol
  47.                     provider.  The message issued to the _TTTT_IIII______BBBB_IIII_NNNN_DDDD _iiii_oooo_cccc_tttt_llll is
  48.                     equivalent to the TI message type _TTTT______BBBB_IIII_NNNN_DDDD______RRRR_EEEE_QQQQ and the
  49.                     message returned by the successful completion of the _iiii_oooo_cccc_tttt_llll
  50.                     is equivalent to the TI message type _TTTT______BBBB_IIII_NNNN_DDDD______AAAA_CCCC_KKKK.
  51.  
  52.      _TTTT_IIII______UUUU_NNNN_BBBB_IIII_NNNN_DDDD      Unbind an address from the underlying transport protocol
  53.                     provider.  The message issued to the _TTTT_IIII______UUUU_NNNN_BBBB_IIII_NNNN_DDDD _iiii_oooo_cccc_tttt_llll is
  54.                     equivalent to the TI message type _TTTT______UUUU_NNNN_BBBB_IIII_NNNN_DDDD______RRRR_EEEE_QQQQ and the
  55.                     message returned by the successful completion of the _iiii_oooo_cccc_tttt_llll
  56.                     is equivalent to the TI message type _TTTT______OOOO_KKKK______AAAA_CCCC_KKKK.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ttttiiiimmmmoooodddd((((7777))))                                                              ttttiiiimmmmoooodddd((((7777))))
  71.  
  72.  
  73.  
  74.      _TTTT_IIII______GGGG_EEEE_TTTT_IIII_NNNN_FFFF_OOOO     Get the TI protocol specific information from the
  75.                     transport protocol provider.  The message issued to the
  76.                     _TTTT_IIII______GGGG_EEEE_TTTT_IIII_NNNN_FFFF_OOOO _iiii_oooo_cccc_tttt_llll is equivalent to the TI message type
  77.                     _TTTT______IIII_NNNN_FFFF_OOOO______RRRR_EEEE_QQQQ and the message
  78.                     returned by the successful completion of the _iiii_oooo_cccc_tttt_llll is
  79.                     equivalent to the TI message type _TTTT______IIII_NNNN_FFFF_OOOO______AAAA_CCCC_KKKK.
  80.  
  81.      _TTTT_IIII______OOOO_PPPP_TTTT_MMMM_GGGG_MMMM_TTTT     Get, set or negotiate protocol specific options with the
  82.                     transport protocol provider.  The message issued to the
  83.                     _TTTT_IIII______OOOO_PPPP_TTTT_MMMM_GGGG_MMMM_TTTT _iiii_oooo_cccc_tttt_llll is equivalent to the TI message type
  84.                     _TTTT______OOOO_PPPP_TTTT_MMMM_GGGG_MMMM_TTTT______RRRR_EEEE_QQQQ and the message returned by the successful
  85.                     completion of the _iiii_oooo_cccc_tttt_llll is equivalent to the TI message
  86.                     type _TTTT______OOOO_PPPP_TTTT_MMMM_GGGG_MMMM_TTTT______AAAA_CCCC_KKKK.
  87.  
  88. FFFFIIIILLLLEEEESSSS
  89.      _<<<<_ssss_yyyy_ssss_////_tttt_iiii_mmmm_oooo_dddd_...._hhhh_>>>>
  90.      _<<<<_ssss_yyyy_ssss_////_tttt_iiii_uuuu_ssss_eeee_rrrr_...._hhhh_>>>>
  91.      _<<<<_ssss_yyyy_ssss_////_tttt_iiii_hhhh_dddd_rrrr_...._hhhh_>>>>
  92.      _<<<<_ssss_yyyy_ssss_////_eeee_rrrr_rrrr_nnnn_oooo_...._hhhh_>>>>
  93.  
  94. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  95.      _tttt_iiii_rrrr_dddd_wwww_rrrr(7)
  96.  
  97. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  98.      If the _iiii_oooo_cccc_tttt_llll system call returns with a value greater than 0, the lower 8
  99.      bits of the return value will be one of the TI error codes as defined in
  100.      _<<<<_ssss_yyyy_ssss_////_tttt_iiii_uuuu_ssss_eeee_rrrr_...._hhhh_>>>>.  If the TI error is of type _TTTT_SSSS_YYYY_SSSS_EEEE_RRRR_RRRR, then the next 8 bits
  101.      of the return value will contain an error as defined in _<<<<_ssss_yyyy_ssss_////_eeee_rrrr_rrrr_nnnn_oooo_...._hhhh_>>>>
  102.      [see _iiii_nnnn_tttt_rrrr_oooo(2)].
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.